home *** CD-ROM | disk | FTP | other *** search
/ Language/OS - Multiplatform Resource Library / LANGUAGE OS.iso / gnu / emacs.lha / emacs-19.16 / lisp / vc.el < prev    next >
Lisp/Scheme  |  1993-07-06  |  71KB  |  1,983 lines
  1. ;;; vc.el --- drive a version-control system from within Emacs
  2.  
  3. ;; Copyright (C) 1992, 1993 Free Software Foundation, Inc.
  4.  
  5. ;; Author: Eric S. Raymond <esr@snark.thyrsus.com>
  6. ;; Version: 5.4
  7.  
  8. ;; This file is part of GNU Emacs.
  9.  
  10. ;; GNU Emacs is free software; you can redistribute it and/or modify
  11. ;; it under the terms of the GNU General Public License as published by
  12. ;; the Free Software Foundation; either version 2, or (at your option)
  13. ;; any later version.
  14.  
  15. ;; GNU Emacs is distributed in the hope that it will be useful,
  16. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18. ;; GNU General Public License for more details.
  19.  
  20. ;; You should have received a copy of the GNU General Public License
  21. ;; along with GNU Emacs; see the file COPYING.  If not, write to
  22. ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  23.  
  24. ;;; Commentary:
  25.  
  26. ;; This mode is fully documented in the Emacs user's manual.
  27. ;;
  28. ;; This was designed and implemented by Eric Raymond <esr@snark.thyrsus.com>.
  29. ;; Paul Eggert <eggert@twinsun.com>, Sebastian Kremer <sk@thp.uni-koeln.de>,
  30. ;; and Richard Stallman contributed valuable criticism, support, and testing.
  31. ;;
  32. ;; Supported version-control systems presently include SCCS and RCS;
  33. ;; your RCS version should be 5.6.2 or later for proper operation of
  34. ;; the lock-breaking code.
  35. ;;
  36. ;; The RCS code assumes strict locking.  You can support the RCS -x option
  37. ;; by adding pairs to the vc-master-templates list.
  38. ;;
  39. ;; Proper function of the SCCS diff commands requires the shellscript vcdiff
  40. ;; to be installed somewhere on Emacs's path for executables.
  41. ;;
  42. ;; If your site uses the ChangeLog convention supported by Emacs, the
  43. ;; function vc-comment-to-change-log should prove a useful checkin hook.
  44. ;;
  45. ;; This code depends on call-process passing back the subprocess exit
  46. ;; status.  Thus, you need Emacs 18.58 or later to run it.  For the
  47. ;; vc-directory command to work properly as documented, you need 19.
  48. ;; You also need Emacs 19's ring.el.
  49. ;;
  50. ;; The vc code maintains some internal state in order to reduce expensive
  51. ;; version-control operations to a minimum.  Some names are only computed
  52. ;; once.  If you perform version control operations with RCS/SCCS/CVS while
  53. ;; vc's back is turned, or move/rename master files while vc is running,
  54. ;; vc may get seriously confused.  Don't do these things!
  55. ;;
  56. ;; Developer's notes on some concurrency issues are included at the end of
  57. ;; the file.
  58.  
  59. ;;; Code:
  60.  
  61. (require 'vc-hooks)
  62. (require 'ring)
  63.  
  64. (if (not (assoc 'vc-parent-buffer minor-mode-alist))
  65.     (setq minor-mode-alist
  66.       (cons '(vc-parent-buffer vc-parent-buffer-name)
  67.         minor-mode-alist)))
  68.  
  69. ;; General customization
  70.  
  71. (defvar vc-default-back-end nil
  72.   "*Back-end actually used by this interface; may be SCCS or RCS.
  73. The value is only computed when needed to avoid an expensive search.")
  74. (defvar vc-suppress-confirm nil
  75.   "*If non-nil, treat user as expert; suppress yes-no prompts on some things.")
  76. (defvar vc-keep-workfiles t
  77.   "*If non-nil, don't delete working files after registering changes.")
  78. (defvar vc-initial-comment nil
  79.   "*Prompt for initial comment when a file is registered.")
  80. (defvar vc-command-messages nil
  81.   "*Display run messages from back-end commands.")
  82. (defvar vc-mistrust-permissions 'file-symlink-p
  83.   "*Don't assume that permissions and ownership track version-control status.")
  84. (defvar vc-checkin-switches nil
  85.   "*Extra switches passed to the checkin program by \\[vc-checkin].")
  86. (defvar vc-path
  87.   (if (file-exists-p "/usr/sccs")
  88.       '("/usr/sccs") nil)
  89.   "*List of extra directories to search for version control commands.")
  90.  
  91. (defconst vc-maximum-comment-ring-size 32
  92.   "Maximum number of saved comments in the comment ring.")
  93.  
  94. ;;; This is duplicated in diff.el.
  95. (defvar diff-switches "-c"
  96.   "*A string or list of strings specifying switches to be be passed to diff.")
  97.  
  98. ;;;###autoload
  99. (defvar vc-checkin-hook nil
  100.   "*List of functions called after a checkin is done.  See `run-hooks'.")
  101.  
  102. ;; Header-insertion hair
  103.  
  104. (defvar vc-header-alist
  105.   '((SCCS "\%W\%") (RCS "\$Id\$"))
  106.   "*Header keywords to be inserted when `vc-insert-headers' is executed.")
  107. (defconst vc-static-header-alist
  108.   '(("\\.c$" .
  109.      "\n#ifndef lint\nstatic char vcid[] = \"\%s\";\n#endif /* lint */\n"))
  110.   "*Associate static header string templates with file types.  A \%s in the
  111. template is replaced with the first string associated with the file's
  112. version-control type in `vc-header-alist'.")
  113.  
  114. (defvar vc-comment-alist
  115.   '((nroff-mode ".\\\"" ""))
  116.   "*Special comment delimiters to be used in generating vc headers only.
  117. Add an entry in this list if you need to override the normal comment-start
  118. and comment-end variables.  This will only be necessary if the mode language
  119. is sensitive to blank lines.")
  120.  
  121. ;; Variables the user doesn't need to know about.
  122. (defvar vc-log-entry-mode nil)
  123. (defvar vc-log-operation nil)
  124. (defvar vc-log-after-operation-hook nil)
  125. (defvar vc-checkout-writable-buffer-hook 'vc-checkout-writable-buffer)
  126. (defvar vc-parent-buffer nil)
  127. (defvar vc-parent-buffer-name nil)
  128.  
  129. (defvar vc-log-file)
  130. (defvar vc-log-version)
  131.  
  132. (defconst vc-name-assoc-file "VC-names")
  133.  
  134. (defvar vc-dired-mode nil)
  135. (make-variable-buffer-local 'vc-dired-mode)
  136.  
  137. (defvar vc-comment-ring nil)
  138. (defvar vc-comment-ring-index nil)
  139. (defvar vc-last-comment-match nil)
  140.  
  141. ;; File property caching
  142.  
  143. (defun vc-file-clearprops (file)
  144.   ;; clear all properties of a given file
  145.   (setplist (intern file vc-file-prop-obarray) nil))
  146.  
  147. (defun vc-clear-context ()
  148.   "Clear all cached file properties and the comment ring."
  149.   (interactive)
  150.   (fillarray vc-file-prop-obarray nil)
  151.   ;; Note: there is potential for minor lossage here if there is an open
  152.   ;; log buffer with a nonzero local value of vc-comment-ring-index.
  153.   (setq vc-comment-ring nil))
  154.  
  155. ;; Random helper functions
  156.  
  157. (defun vc-registration-error (file)
  158.   (if file
  159.       (error "File %s is not under version control" file)
  160.     (error "Buffer %s is not associated with a file" (buffer-name))))
  161.  
  162. (defvar vc-binary-assoc nil)
  163.  
  164. (defun vc-find-binary (name)
  165.   "Look for a command anywhere on the subprocess-command search path."
  166.   (or (cdr (assoc name vc-binary-assoc))
  167.       (let ((full nil))
  168.     (catch 'found
  169.       (mapcar
  170.        (function (lambda (s)
  171.           (if (and s (file-exists-p (setq full (concat s "/" name))))
  172.           (throw 'found nil))))
  173.       exec-path))
  174.     (if full
  175.         (setq vc-binary-assoc (cons (cons name full) vc-binary-assoc)))
  176.     full)))
  177.  
  178. (defun vc-do-command (okstatus command file &rest flags)
  179.   "Execute a version-control command, notifying user and checking for errors.
  180. The command is successful if its exit status does not exceed OKSTATUS.
  181. Output from COMMAND goes to buffer *vc*.  The last argument of the command is
  182. the master name of FILE; this is appended to an optional list of FLAGS."
  183.   (setq file (expand-file-name file))
  184.   (if vc-command-messages
  185.       (message "Running %s on %s..." command file))
  186.   (let ((obuf (current-buffer)) (camefrom (current-buffer))
  187.     (squeezed nil)
  188.     (vc-file (and file (vc-name file)))
  189.     status)
  190.     (set-buffer (get-buffer-create "*vc*"))
  191.     (set (make-local-variable 'vc-parent-buffer) camefrom)
  192.     (set (make-local-variable 'vc-parent-buffer-name)
  193.      (concat " from " (buffer-name camefrom)))
  194.     
  195.     (erase-buffer)
  196.  
  197.     ;; This is so that command arguments typed in the *vc* buffer will
  198.     ;; have reasonable defaults.
  199.     (setq default-directory (file-name-directory file))
  200.  
  201.     (mapcar
  202.      (function (lambda (s) (and s (setq squeezed (append squeezed (list s))))))
  203.      flags)
  204.     (if vc-file
  205.     (setq squeezed (append squeezed (list vc-file))))
  206.     (let ((default-directory (file-name-directory (or file "./")))
  207.       (exec-path (if vc-path (append exec-path vc-path) exec-path)))
  208.       (setq status (apply 'call-process command nil t nil squeezed)))
  209.     (goto-char (point-max))
  210.     (previous-line 1)
  211.     (if (or (not (integerp status)) (< okstatus status))
  212.     (progn
  213.       (previous-line 1)
  214.       (print (cons command squeezed))
  215.       (next-line 1)
  216.       (pop-to-buffer "*vc*")
  217.       (vc-shrink-to-fit)
  218.       (goto-char (point-min))
  219.       (error "Running %s...FAILED (%s)" command
  220.          (if (integerp status)
  221.              (format "status %d" status)
  222.            status))
  223.       )
  224.       (if vc-command-messages
  225.       (message "Running %s...OK" command))
  226.       )
  227.     (set-buffer obuf)
  228.     status)
  229.   )
  230.  
  231. ;;; Save a bit of the text around POSN in the current buffer, to help
  232. ;;; us find the corresponding position again later.  This works even
  233. ;;; if all markers are destroyed or corrupted.
  234. (defun vc-position-context (posn)
  235.   (list posn
  236.     (buffer-size)
  237.     (buffer-substring posn
  238.               (min (point-max) (+ posn 100)))))
  239.  
  240. ;;; Return the position of CONTEXT in the current buffer, or nil if we
  241. ;;; couldn't find it.
  242. (defun vc-find-position-by-context (context)
  243.   (let ((context-string (nth 2 context)))
  244.     (if (equal "" context-string)
  245.     (point-max)
  246.       (save-excursion
  247.     (let ((diff (- (nth 1 context) (buffer-size))))
  248.       (if (< diff 0) (setq diff (- diff)))
  249.       (goto-char (nth 0 context))
  250.       (if (or (search-forward context-string nil t)
  251.           ;; Can't use search-backward since the match may continue
  252.           ;; after point.
  253.           (progn (goto-char (- (point) diff (length context-string)))
  254.              ;; goto-char doesn't signal an error at
  255.              ;; beginning of buffer like backward-char would
  256.              (search-forward context-string nil t)))
  257.           ;; to beginning of OSTRING
  258.           (- (point) (length context-string))))))))
  259.  
  260. (defun vc-revert-buffer1 (&optional arg no-confirm)
  261.   ;; Most of this was shamelessly lifted from Sebastian Kremer's rcs.el mode.
  262.   ;; Revert buffer, try to keep point and mark where user expects them in spite
  263.   ;; of changes because of expanded version-control key words.
  264.   ;; This is quite important since otherwise typeahead won't work as expected.
  265.   (interactive "P")
  266.   (widen)
  267.   (let ((point-context (vc-position-context (point)))
  268.     ;; Use mark-marker to avoid confusion in transient-mark-mode.
  269.     (mark-context  (if (eq (marker-buffer (mark-marker)) (current-buffer))
  270.                (vc-position-context (mark-marker))))
  271.     ;; Make the right thing happen in transient-mark-mode.
  272.     (mark-active nil)
  273.     ;; We may want to reparse the compilation buffer after revert
  274.     (reparse (and (boundp 'compilation-error-list) ;compile loaded
  275.               (let ((curbuf (current-buffer)))
  276.             ;; Construct a list; each elt is nil or a buffer
  277.             ;; iff that buffer is a compilation output buffer
  278.             ;; that contains markers into the current buffer.
  279.             (save-excursion
  280.               (mapcar (function
  281.                    (lambda (buffer)
  282.                     (set-buffer buffer)
  283.                     (let ((errors (or
  284.                            compilation-old-error-list
  285.                            compilation-error-list))
  286.                       (buffer-error-marked-p nil))
  287.                       (while (and (consp errors)
  288.                           (not buffer-error-marked-p))
  289.                     (and (markerp (cdr (car errors)))
  290.                          (eq buffer
  291.                          (marker-buffer
  292.                           (cdr (car errors))))
  293.                          (setq buffer-error-marked-p t))
  294.                     (setq errors (cdr errors)))
  295.                       (if buffer-error-marked-p buffer))))
  296.                   (buffer-list)))))))
  297.  
  298.     ;; the actual revisit
  299.     (revert-buffer arg no-confirm)
  300.  
  301.     ;; Reparse affected compilation buffers.
  302.     (while reparse
  303.       (if (car reparse)
  304.       (save-excursion
  305.         (set-buffer (car reparse))
  306.         (let ((compilation-last-buffer (current-buffer)) ;select buffer
  307.           ;; Record the position in the compilation buffer of
  308.           ;; the last error next-error went to.
  309.           (error-pos (marker-position
  310.                   (car (car-safe compilation-error-list)))))
  311.           ;; Reparse the error messages as far as they were parsed before.
  312.           (compile-reinitialize-errors '(4) compilation-parsing-end)
  313.           ;; Move the pointer up to find the error we were at before
  314.           ;; reparsing.  Now next-error should properly go to the next one.
  315.           (while (and compilation-error-list
  316.               (/= error-pos (car (car compilation-error-list))))
  317.         (setq compilation-error-list (cdr compilation-error-list))))))
  318.       (setq reparse (cdr reparse)))
  319.  
  320.     ;; Restore point and mark
  321.     (let ((new-point (vc-find-position-by-context point-context)))
  322.       (if new-point (goto-char new-point)))
  323.     (if mark-context
  324.     (let ((new-mark (vc-find-position-by-context mark-context)))
  325.       (if new-mark (set-mark new-mark))))))
  326.  
  327.  
  328. (defun vc-buffer-sync ()
  329.   ;; Make sure the current buffer and its working file are in sync
  330.   (if (and (buffer-modified-p)
  331.        (or
  332.         vc-suppress-confirm
  333.         (y-or-n-p (format "%s has been modified.  Write it out? "
  334.                   (buffer-name)))))
  335.       (save-buffer)))
  336.  
  337. (defun vc-workfile-unchanged-p (file)
  338.   ;; Has the given workfile changed since last checkout?
  339.   (let ((checkout-time (vc-file-getprop file 'vc-checkout-time))
  340.     (lastmod (nth 5 (file-attributes file))))
  341.     (if checkout-time
  342.      (equal lastmod checkout-time)
  343.      (if (zerop (vc-backend-diff file nil))
  344.      (progn
  345.        (vc-file-setprop file 'vc-checkout-time lastmod)
  346.        t)
  347.        (progn
  348.        (vc-file-setprop file 'vc-checkout-time '(0 . 0))
  349.        nil
  350.      ))
  351.      )))
  352.  
  353. (defun vc-next-action-on-file (file verbose &optional comment)
  354.   ;;; If comment is specified, it will be used as an admin or checkin comment.
  355.   (let (owner version (vc-file (vc-name file)))
  356.     (cond
  357.  
  358.      ;; if there is no master file corresponding, create one
  359.      ((not vc-file)
  360.       (vc-register verbose comment)
  361.       (if vc-initial-comment
  362.       (setq vc-log-after-operation-hook
  363.         'vc-checkout-writable-buffer-hook)
  364.     (vc-checkout-writable-buffer file)))
  365.  
  366.      ;; if there is no lock on the file, assert one and get it
  367.      ((not (setq owner (vc-locking-user file)))
  368.       (vc-checkout-writable-buffer file))
  369.  
  370.      ;; a checked-out version exists, but the user may not own the lock
  371.      ((not (string-equal owner (user-login-name)))
  372.       (if comment
  373.       (error "Sorry, you can't steal the lock on %s this way" file))
  374.       (vc-steal-lock
  375.        file
  376.        (and verbose (read-string "Version to steal: "))
  377.        owner))
  378.      
  379.      ;; OK, user owns the lock on the file
  380.      (t
  381.       (find-file file)
  382.  
  383.       ;; give luser a chance to save before checking in.
  384.       (vc-buffer-sync)
  385.  
  386.       ;; Revert if file is unchanged and buffer is too.
  387.       ;; If buffer is modified, that means the user just said no
  388.       ;; to saving it; in that case, don't revert,
  389.       ;; because the user might intend to save
  390.       ;; after finishing the log entry.
  391.       (if (and (vc-workfile-unchanged-p file)
  392.            (not (buffer-modified-p)))
  393.           (progn
  394.         (vc-backend-revert file)
  395.         ;; DO NOT revert the file without asking the user!
  396.         (vc-resynch-window file t nil))
  397.  
  398.         ;; user may want to set nonstandard parameters
  399.         (if verbose
  400.         (setq version (read-string "New version level: ")))
  401.  
  402.         ;; OK, let's do the checkin
  403.         (vc-checkin file version comment)
  404.         )))))
  405.  
  406. (defun vc-next-action-dired (file rev comment)
  407.   ;; We've accepted a log comment, now do a vc-next-action using it on all
  408.   ;; marked files.
  409.   (set-buffer vc-parent-buffer)
  410.   (dired-map-over-marks
  411.    (save-window-excursion
  412.      (let ((file (dired-get-filename)))
  413.        (message "Processing %s..." file)
  414.        (vc-next-action-on-file file nil comment)
  415.        (message "Processing %s...done" file)))
  416.    nil t)
  417.   )
  418.  
  419. ;; Here's the major entry point.
  420.  
  421. ;;;###autoload
  422. (defun vc-next-action (verbose)
  423.   "Do the next logical checkin or checkout operation on the current file.
  424.    If the file is not already registered, this registers it for version
  425. control and then retrieves a writable, locked copy for editing.
  426.    If the file is registered and not locked by anyone, this checks out
  427. a writable and locked file ready for editing.
  428.    If the file is checked out and locked by the calling user, this
  429. first checks to see if the file has changed since checkout.  If not,
  430. it performs a revert.
  431.    If the file has been changed, this pops up a buffer for entry
  432. of a log message; when the message has been entered, it checks in the
  433. resulting changes along with the log message as change commentary.  If
  434. the variable `vc-keep-workfiles' is non-nil (which is its default), a
  435. read-only copy of the changed file is left in place afterwards.
  436.    If the file is registered and locked by someone else, you are given
  437. the option to steal the lock.
  438.    If you call this from within a VC dired buffer with no files marked,
  439. it will operate on the file in the current line.
  440.    If you call this from within a VC dired buffer, and one or more
  441. files are marked, it will accept a log message and then operate on
  442. each one.  The log message will be used as a comment for any register
  443. or checkin operations, but ignored when doing checkouts.  Attempted
  444. lock steals will raise an error."
  445.   (interactive "P")
  446.   (catch 'nogo
  447.     (if vc-dired-mode
  448.     (let ((files (dired-get-marked-files)))
  449.       (if (= (length files) 1)
  450.           (find-file-other-window (dired-get-filename))
  451.         (vc-start-entry nil nil nil
  452.                 "Enter a change comment for the marked files."
  453.                 'vc-next-action-dired)
  454.         (throw 'nogo))))
  455.     (while vc-parent-buffer
  456.       (pop-to-buffer vc-parent-buffer))
  457.     (if buffer-file-name
  458.     (vc-next-action-on-file buffer-file-name verbose)
  459.       (vc-registration-error nil))))
  460.  
  461. ;;; These functions help the vc-next-action entry point
  462.  
  463. (defun vc-checkout-writable-buffer (&optional file)
  464.   "Retrieve a writable copy of the latest version of the current buffer's file."
  465.   (vc-checkout (or file (buffer-file-name)) t)
  466.   )
  467.  
  468. ;;;###autoload
  469. (defun vc-register (&optional override comment)
  470.   "Register the current file into your version-control system."
  471.   (interactive "P")
  472.   (if (vc-name buffer-file-name)
  473.       (error "This file is already registered"))
  474.   ;; Watch out for new buffers of size 0: the corresponding file
  475.   ;; does not exist yet, even though buffer-modified-p is nil.
  476.   (if (and (not (buffer-modified-p))
  477.        (zerop (buffer-size))
  478.        (not (file-exists-p buffer-file-name)))
  479.       (set-buffer-modified-p t))
  480.   (vc-buffer-sync)
  481.   (vc-admin
  482.    buffer-file-name
  483.    (and override
  484.     (read-string
  485.      (format "Initial version level for %s: " buffer-file-name))))
  486.   )
  487.  
  488. (defun vc-resynch-window (file &optional keep noquery)
  489.   ;; If the given file is in the current buffer,
  490.   ;; either revert on it so we see expanded keyworks,
  491.   ;; or unvisit it (depending on vc-keep-workfiles)
  492.   ;; NOQUERY if non-nil inhibits confirmation for reverting.
  493.   ;; NOQUERY should be t *only* if it is known the only difference
  494.   ;; between the buffer and the file is due to RCS rather than user editing!
  495.   (and (string= buffer-file-name file)
  496.        (if keep
  497.        (progn
  498.          (vc-revert-buffer1 t noquery)
  499.          (vc-mode-line buffer-file-name))
  500.      (progn
  501.        (delete-window)
  502.        (kill-buffer (current-buffer))))))
  503.  
  504. (defun vc-start-entry (file rev comment msg action)
  505.   ;; Accept a comment for an operation on FILE revision REV.  If COMMENT
  506.   ;; is nil, pop up a VC-log buffer, emit MSG, and set the
  507.   ;; action on close to ACTION; otherwise, do action immediately.
  508.   ;; Remember the file's buffer in parent-buffer (current one if no file).
  509.   (let ((parent (if file (find-file-noselect file) (current-buffer))))
  510.     (if comment
  511.     (set-buffer (get-buffer-create "*VC-log*"))
  512.       (pop-to-buffer (get-buffer-create "*VC-log*")))
  513.     (set (make-local-variable 'vc-parent-buffer) parent)
  514.     (set (make-local-variable 'vc-parent-buffer-name)
  515.      (concat " from " (buffer-name vc-parent-buffer)))
  516.     (vc-mode-line (or file " (no file)"))
  517.     (vc-log-mode)
  518.     (setq vc-log-operation action)
  519.     (setq vc-log-file file)
  520.     (setq vc-log-version rev)
  521.     (if comment
  522.     (progn
  523.       (erase-buffer)
  524.       (if (eq comment t)
  525.           (vc-finish-logentry t)
  526.         (insert comment)
  527.         (vc-finish-logentry nil)))
  528.       (message "%s  Type C-c C-c when done." msg))))
  529.  
  530. (defun vc-admin (file rev &optional comment)
  531.   "Check a file into your version-control system.
  532. FILE is the unmodified name of the file.  REV should be the base version
  533. level to check it in under.  COMMENT, if specified, is the checkin comment."
  534.       (vc-start-entry file rev
  535.               (or comment (not vc-initial-comment))
  536.               "Enter initial comment." 'vc-backend-admin))
  537.  
  538. (defun vc-checkout (file &optional writable)
  539.   "Retrieve a copy of the latest version of the given file."
  540.   ;; If ftp is on this system and the name matches the ange-ftp format
  541.   ;; for a remote file, the user is trying something that won't work.
  542.   (if (and (string-match "^/[^/:]+:" file) (vc-find-binary "ftp"))
  543.       (error "Sorry, you can't check out files over FTP"))
  544.   (vc-backend-checkout file writable)
  545.   (if (string-equal file buffer-file-name)
  546.       (vc-resynch-window file t t))
  547.   )
  548.  
  549. (defun vc-steal-lock (file rev &optional owner)
  550.   "Steal the lock on the current workfile."
  551.   (interactive)
  552.   (if (not owner)
  553.       (setq owner (vc-locking-user file)))
  554.   (if (not (y-or-n-p (format "Take the lock on %s:%s from %s? " file rev owner)))
  555.       (error "Steal cancelled"))
  556.   (pop-to-buffer (get-buffer-create "*VC-mail*"))
  557.   (setq default-directory (expand-file-name "~/"))
  558.   (auto-save-mode auto-save-default)
  559.   (mail-mode)
  560.   (erase-buffer)
  561.   (mail-setup owner (format "%s:%s" file rev) nil nil nil
  562.           (list (list 'vc-finish-steal file rev)))
  563.   (goto-char (point-max))
  564.   (insert
  565.    (format "I stole the lock on %s:%s, " file rev)
  566.    (current-time-string)
  567.    ".\n")
  568.   (message "Please explain why you stole the lock.  Type C-c C-c when done."))
  569.  
  570. ;; This is called when the notification has been sent.
  571. (defun vc-finish-steal (file version)
  572.   (vc-backend-steal file version)
  573.   (vc-resynch-window file t t))
  574.  
  575. (defun vc-checkin (file &optional rev comment)
  576.   "Check in the file specified by FILE.
  577. The optional argument REV may be a string specifying the new version level
  578. \(if nil increment the current level).  The file is either retained with write
  579. permissions zeroed, or deleted (according to the value of `vc-keep-workfiles').
  580. COMMENT is a comment string; if omitted, a buffer is
  581. popped up to accept a comment."
  582.   (setq vc-log-after-operation-hook 'vc-checkin-hook)
  583.   (vc-start-entry file rev comment "Enter a change comment." 'vc-backend-checkin))
  584.  
  585. ;;; Here is a checkin hook that may prove useful to sites using the
  586. ;;; ChangeLog facility supported by Emacs.
  587. (defun vc-comment-to-change-log ()
  588.   "Update change log from VC change comments entered for the current file.
  589. See `vc-update-change-log'."
  590.   (interactive)
  591.   (let ((log (find-change-log)))
  592.     (if log
  593.     (vc-update-change-log
  594.      (file-relative-name buffer-file-name
  595.                  (file-name-directory (expand-file-name log)))))))
  596.  
  597. (defun vc-finish-logentry (&optional nocomment)
  598.   "Complete the operation implied by the current log entry."
  599.   (interactive)
  600.   ;; Check and record the comment, if any.
  601.   (if (not nocomment)
  602.       (progn
  603.     (goto-char (point-max))
  604.     (if (not (bolp))
  605.         (newline))
  606.     ;; Comment too long?
  607.     (vc-backend-logentry-check vc-log-file)
  608.     ;; Record the comment in the comment ring
  609.     (if (null vc-comment-ring)
  610.         (setq vc-comment-ring (make-ring vc-maximum-comment-ring-size)))
  611.     (ring-insert vc-comment-ring (buffer-string))
  612.     ))
  613.   ;; OK, do it to it
  614.   (if vc-log-operation
  615.       (save-excursion
  616.     (funcall vc-log-operation 
  617.          vc-log-file
  618.          vc-log-version
  619.          (buffer-string)))
  620.     (error "No log operation is pending"))
  621.   ;; Return to "parent" buffer of this checkin and remove checkin window
  622.   (pop-to-buffer vc-parent-buffer)
  623.   (delete-windows-on (get-buffer "*VC-log*"))
  624.   (kill-buffer "*VC-log*")
  625.   ;; Now make sure we see the expanded headers
  626.   (if buffer-file-name
  627.     (vc-resynch-window buffer-file-name vc-keep-workfiles t))
  628.   (run-hooks vc-log-after-operation-hook))
  629.  
  630. ;; Code for access to the comment ring
  631.  
  632. (defun vc-previous-comment (arg)
  633.   "Cycle backwards through comment history."
  634.   (interactive "*p")
  635.   (let ((len (ring-length vc-comment-ring)))
  636.     (cond ((<= len 0)
  637.        (message "Empty comment ring")
  638.        (ding))
  639.       (t
  640.        (erase-buffer)
  641.        ;; Initialize the index on the first use of this command
  642.        ;; so that the first M-p gets index 0, and the first M-n gets
  643.        ;; index -1.
  644.        (if (null vc-comment-ring-index)
  645.            (setq vc-comment-ring-index
  646.              (if (> arg 0) -1
  647.              (if (< arg 0) 1 0))))
  648.        (setq vc-comment-ring-index
  649.          (ring-mod (+ vc-comment-ring-index arg) len))
  650.        (message "%d" (1+ vc-comment-ring-index))
  651.        (insert (ring-ref vc-comment-ring vc-comment-ring-index))))))
  652.  
  653. (defun vc-next-comment (arg)
  654.   "Cycle forwards through comment history."
  655.   (interactive "*p")
  656.   (vc-previous-comment (- arg)))
  657.  
  658. (defun vc-comment-search-reverse (str)
  659.   "Searches backwards through comment history for substring match."
  660.   (interactive "sComment substring: ")
  661.   (if (string= str "")
  662.       (setq str vc-last-comment-match)
  663.     (setq vc-last-comment-match str))
  664.   (if (null vc-comment-ring-index)
  665.       (setq vc-comment-ring-index -1))
  666.   (let ((str (regexp-quote str))
  667.         (len (ring-length vc-comment-ring))
  668.     (n (1+ vc-comment-ring-index)))
  669.     (while (and (< n len) (not (string-match str (ring-ref vc-comment-ring n))))
  670.       (setq n (+ n 1)))
  671.     (cond ((< n len)
  672.        (vc-previous-comment (- n vc-comment-ring-index)))
  673.       (t (error "Not found")))))
  674.  
  675. (defun vc-comment-search-forward (str)
  676.   "Searches forwards through comment history for substring match."
  677.   (interactive "sComment substring: ")
  678.   (if (string= str "")
  679.       (setq str vc-last-comment-match)
  680.     (setq vc-last-comment-match str))
  681.   (if (null vc-comment-ring-index)
  682.       (setq vc-comment-ring-index 0))
  683.   (let ((str (regexp-quote str))
  684.         (len (ring-length vc-comment-ring))
  685.     (n vc-comment-ring-index))
  686.     (while (and (>= n 0) (not (string-match str (ring-ref vc-comment-ring n))))
  687.       (setq n (- n 1)))
  688.     (cond ((>= n 0)
  689.        (vc-next-comment (- n vc-comment-ring-index)))
  690.       (t (error "Not found")))))
  691.  
  692. ;; Additional entry points for examining version histories
  693.  
  694. ;;;###autoload
  695. (defun vc-diff (historic)
  696.   "Display diffs between file versions.
  697. Normally this compares the current file and buffer with the most recent 
  698. checked in version of that file.  This uses no arguments.
  699. With a prefix argument, it reads the file name to use
  700. and two version designators specifying which versions to compare."
  701.   (interactive "P")
  702.   (if vc-dired-mode
  703.       (set-buffer (find-file-noselect (dired-get-filename))))
  704.   (while vc-parent-buffer
  705.       (pop-to-buffer vc-parent-buffer))
  706.   (if historic
  707.       (call-interactively 'vc-version-diff)
  708.     (if (or (null buffer-file-name) (null (vc-name buffer-file-name)))
  709.     (error "There is no version-control master associated with this buffer"))
  710.     (let ((file buffer-file-name)
  711.       unchanged)
  712.       (or (and file (vc-name file))
  713.       (vc-registration-error file))
  714.       (vc-buffer-sync)
  715.       (setq unchanged (vc-workfile-unchanged-p buffer-file-name))
  716.       (if unchanged
  717.       (message "No changes to %s since latest version." file)
  718.     (vc-backend-diff file nil)
  719.     ;; Ideally, we'd like at this point to parse the diff so that
  720.     ;; the buffer effectively goes into compilation mode and we
  721.     ;; can visit the old and new change locations via next-error.
  722.     ;; Unfortunately, this is just too painful to do.  The basic
  723.     ;; problem is that the `old' file doesn't exist to be
  724.     ;; visited.  This plays hell with numerous assumptions in
  725.     ;; the diff.el and compile.el machinery.
  726.     (pop-to-buffer "*vc*")
  727.     (pop-to-buffer "*vc*")
  728.     (if (= 0 (buffer-size))
  729.         (progn
  730.           (setq unchanged t)
  731.           (message "No changes to %s since latest version." file))
  732.       (vc-shrink-to-fit)
  733.       (goto-char (point-min)))
  734.  
  735.     )
  736.       (not unchanged)
  737.       )
  738.     )
  739.   )
  740.  
  741. (defun vc-version-diff (file rel1 rel2)
  742.   "For FILE, report diffs between two stored versions REL1 and REL2 of it.
  743. If FILE is a directory, generate diffs between versions for all registered
  744. files in or below it."
  745.   (interactive "FFile or directory to diff: \nsOlder version: \nsNewer version: ")
  746.   (if (string-equal rel1 "") (setq rel1 nil))
  747.   (if (string-equal rel2 "") (setq rel2 nil))
  748.   (if (file-directory-p file)
  749.       (let ((camefrom (current-buffer)))
  750.     (set-buffer (get-buffer-create "*vc-status*"))
  751.     (set (make-local-variable 'vc-parent-buffer) camefrom)
  752.     (set (make-local-variable 'vc-parent-buffer-name)
  753.          (concat " from " (buffer-name camefrom)))
  754.     (erase-buffer)
  755.     (insert "Diffs between "
  756.         (or rel1 "last version checked in")
  757.         " and "
  758.         (or rel2 "current workfile(s)")
  759.         ":\n\n")
  760.     (set-buffer (get-buffer-create "*vc*"))
  761.     (cd file)
  762.     (vc-file-tree-walk
  763.      (function (lambda (f)
  764.              (message "Looking at %s" f)
  765.              (and
  766.               (not (file-directory-p f))
  767.               (vc-registered f)
  768.               (vc-backend-diff f rel1 rel2)
  769.               (append-to-buffer "*vc-status*" (point-min) (point-max)))
  770.              )))
  771.     (pop-to-buffer "*vc-status*")
  772.     (insert "\nEnd of diffs.\n")
  773.     (goto-char (point-min))
  774.     (set-buffer-modified-p nil)
  775.     )
  776.     (if (zerop (vc-backend-diff file rel1 rel2))
  777.     (message "No changes to %s between %s and %s." file rel1 rel2)
  778.       (pop-to-buffer "*vc*"))))
  779.  
  780. ;; Header-insertion code
  781.  
  782. ;;;###autoload
  783. (defun vc-insert-headers ()
  784.   "Insert headers in a file for use with your version-control system.
  785. Headers desired are inserted at the start of the buffer, and are pulled from
  786. the variable `vc-header-alist'."
  787.   (interactive)
  788.   (if vc-dired-mode
  789.       (find-file-other-window (dired-get-filename)))
  790.   (while vc-parent-buffer
  791.       (pop-to-buffer vc-parent-buffer))
  792.   (save-excursion
  793.     (save-restriction
  794.       (widen)
  795.       (if (or (not (vc-check-headers))
  796.           (y-or-n-p "Version headers already exist.  Insert another set? "))
  797.       (progn
  798.         (let* ((delims (cdr (assq major-mode vc-comment-alist)))
  799.            (comment-start-vc (or (car delims) comment-start "#"))
  800.            (comment-end-vc (or (car (cdr delims)) comment-end ""))
  801.            (hdstrings (cdr (assoc (vc-backend-deduce (buffer-file-name)) vc-header-alist))))
  802.           (mapcar (function (lambda (s)
  803.                   (insert comment-start-vc "\t" s "\t"
  804.                       comment-end-vc "\n")))
  805.               hdstrings)
  806.           (if vc-static-header-alist
  807.           (mapcar (function (lambda (f)
  808.                       (if (string-match (car f) buffer-file-name)
  809.                       (insert (format (cdr f) (car hdstrings))))))
  810.               vc-static-header-alist))
  811.           )
  812.         )))))
  813.  
  814. ;; The VC directory submode.  Coopt Dired for this.
  815. ;; All VC commands get mapped into logical equivalents.
  816.  
  817. (defvar vc-dired-prefix-map (make-sparse-keymap))
  818. (define-key vc-dired-prefix-map "\C-xv" vc-prefix-map)
  819.  
  820. (or (not (boundp 'minor-mode-map-alist))
  821.     (assq 'vc-dired-mode minor-mode-map-alist)
  822.     (setq minor-mode-map-alist
  823.        (cons (cons 'vc-dired-mode vc-dired-prefix-map)
  824.          minor-mode-map-alist)))
  825.  
  826. (defun vc-dired-mode ()
  827.   "The augmented Dired minor mode used in VC directory buffers.
  828. All Dired commands operate normally.  Users currently locking listed files
  829. are listed in place of the file's owner and group.
  830. Keystrokes bound to VC commands will execute as though they had been called
  831. on a buffer attached to the file named in the current Dired buffer line."
  832.   (setq vc-dired-mode t)
  833.   (setq vc-mode " under VC"))
  834.  
  835. (defun vc-dired-reformat-line (x)
  836.   ;; Hack a directory-listing line, plugging in locking-user info in
  837.   ;; place of the user and group info.  Should have the beneficial
  838.   ;; side-effect of shortening the listing line.  Each call starts with
  839.   ;; point immediately following the dired mark area on the line to be
  840.   ;; hacked.
  841.   ;;
  842.   ;; Simplest possible one:
  843.   ;; (insert (concat x "\t")))
  844.   ;;
  845.   ;; This code, like dired, assumes UNIX -l format.
  846.   (forward-word 1)    ;; skip over any extra field due to -ibs options
  847.   (if x (setq x (concat "(" x ")")))
  848.   (if (re-search-forward "\\([0-9]+ \\).................\\( .*\\)" nil 0)
  849.       (let ((rep (substring (concat x "                 ") 0 9)))
  850.     (replace-match (concat "\\1" rep "\\2") t)))
  851.   )
  852.  
  853. ;;; Note in Emacs 18 the following defun gets overridden
  854. ;;; with the symbol 'vc-directory-18.  See below.
  855. ;;;###autoload
  856. (defun vc-directory (verbose)
  857.   "Show version-control status of all files under the current directory."
  858.   (interactive "P")
  859.   (let (nonempty
  860.     (dl (length default-directory))
  861.     (filelist nil) (userlist nil)
  862.     dired-buf
  863.     dired-buf-mod-count)
  864.     (vc-file-tree-walk
  865.      (function (lambda (f)
  866.          (if (vc-registered f)
  867.              (let ((user (vc-locking-user f)))
  868.                (and (or verbose user)
  869.                 (setq filelist (cons (substring f dl) filelist))
  870.                 (setq userlist (cons user userlist))))))))
  871.     (save-excursion
  872.       ;; This uses a semi-documented feature of dired; giving a switch
  873.       ;; argument forces the buffer to refresh each time.
  874.       (dired
  875.        (cons default-directory (nreverse filelist))
  876.        dired-listing-switches)
  877.       (setq dired-buf (current-buffer))
  878.       (setq nonempty (not (zerop (buffer-size)))))
  879.     (if nonempty
  880.     (progn
  881.       (pop-to-buffer dired-buf)
  882.       (vc-dired-mode)
  883.       (goto-char (point-min))
  884.       (setq buffer-read-only nil)
  885.       (forward-line 1)    ;; Skip header line
  886.       (mapcar
  887.        (function
  888.         (lambda (x)
  889.          (forward-char 2)    ;; skip dired's mark area
  890.          (vc-dired-reformat-line x)
  891.          (forward-line 1)))    ;; go to next line
  892.        (nreverse userlist))
  893.       (setq buffer-read-only t)
  894.       (goto-char (point-min))
  895.       )
  896.       (message "No files are currently %s under %s"
  897.            (if verbose "registered" "locked") default-directory))
  898.     ))
  899.  
  900. ;; Emacs 18 version
  901. (defun vc-directory-18 (verbose)
  902.   "Show version-control status of all files under the current directory."
  903.   (interactive "P")
  904.   (let (nonempty (dir default-directory))
  905.     (save-excursion
  906.       (set-buffer (get-buffer-create "*vc-status*"))
  907.       (erase-buffer)
  908.       (cd dir)
  909.       (vc-file-tree-walk
  910.        (function (lambda (f)
  911.            (if (vc-registered f)
  912.                (let ((user (vc-locking-user f)))
  913.              (if (or user verbose)
  914.                  (insert (format
  915.                       "%s    %s\n"
  916.                       (concat user) f))))))))
  917.       (setq nonempty (not (zerop (buffer-size)))))
  918.     (if nonempty
  919.     (progn
  920.       (pop-to-buffer "*vc-status*" t)
  921.       (vc-shrink-to-fit)
  922.       (goto-char (point-min)))
  923.       (message "No files are currently %s under %s"
  924.            (if verbose "registered" "locked") default-directory))
  925.     ))
  926.  
  927. (or (boundp 'minor-mode-map-alist)
  928.     (fset 'vc-directory 'vc-directory-18))
  929.  
  930. ; Emacs 18 also lacks these.
  931. (or (boundp 'compilation-old-error-list)
  932.     (setq compilation-old-error-list nil))
  933.  
  934. ;; Named-configuration support for SCCS
  935.  
  936. (defun vc-add-triple (name file rev)
  937.   (save-excursion
  938.     (find-file (concat (vc-backend-subdirectory-name file) "/" vc-name-assoc-file))
  939.     (goto-char (point-max))
  940.     (insert name "\t:\t" file "\t" rev "\n")
  941.     (basic-save-buffer)
  942.     (kill-buffer (current-buffer))
  943.     ))
  944.  
  945. (defun vc-record-rename (file newname)
  946.   (save-excursion
  947.     (find-file (concat (vc-backend-subdirectory-name file) "/" vc-name-assoc-file))
  948.     (goto-char (point-min))
  949.     (replace-regexp (concat ":" (regexp-quote file) "$") (concat ":" newname))
  950.     (basic-save-buffer)
  951.     (kill-buffer (current-buffer))
  952.     ))
  953.  
  954. (defun vc-lookup-triple (file name)
  955.   ;; Return the numeric version corresponding to a named snapshot of file
  956.   ;; If name is nil or a version number string it's just passed through
  957.   (cond ((null name) "")
  958.     ((let ((firstchar (aref name 0)))
  959.        (and (>= firstchar ?0) (<= firstchar ?9)))
  960.      name)
  961.     (t
  962.      (car (vc-master-info
  963.            (concat (vc-backend-subdirectory-name file) "/" vc-name-assoc-file)
  964.            (list (concat name "\t:\t" file "\t\\(.+\\)"))))
  965.      )))
  966.  
  967. ;; Named-configuration entry points
  968.  
  969. (defun vc-quiescent-p ()
  970.   ;; Is the current directory ready to be snapshot?
  971.   (catch 'quiet
  972.     (vc-file-tree-walk
  973.      (function (lambda (f)
  974.          (if (and (vc-registered f) (vc-locking-user f))
  975.              (throw 'quiet nil)))))
  976.     t))
  977.  
  978. ;;;###autoload
  979. (defun vc-create-snapshot (name)
  980.   "Make a snapshot called NAME.
  981. The snapshot is made from all registered files at or below the current
  982. directory.  For each file, the version level of its latest
  983. version becomes part of the named configuration."
  984.   (interactive "sNew snapshot name: ")
  985.   (if (not (vc-quiescent-p))
  986.       (error "Can't make a snapshot since some files are locked")
  987.     (vc-file-tree-walk
  988.      (function (lambda (f) (and
  989.            (vc-name f)
  990.            (vc-backend-assign-name f name)))))
  991.     ))
  992.  
  993. ;;;###autoload
  994. (defun vc-retrieve-snapshot (name)
  995.   "Retrieve the snapshot called NAME.
  996. This function fails if any files are locked at or below the current directory
  997. Otherwise, all registered files are checked out (unlocked) at their version
  998. levels in the snapshot."
  999.   (interactive "sSnapshot name to retrieve: ")
  1000.   (if (not (vc-quiescent-p))
  1001.       (error "Can't retrieve snapshot sine some files are locked")
  1002.     (vc-file-tree-walk
  1003.      (function (lambda (f) (and
  1004.            (vc-name f)
  1005.            (vc-error-occurred (vc-backend-checkout f nil name))))))
  1006.     ))
  1007.  
  1008. ;; Miscellaneous other entry points
  1009.  
  1010. ;;;###autoload
  1011. (defun vc-print-log ()
  1012.   "List the change log of the current buffer in a window."
  1013.   (interactive)
  1014.   (if vc-dired-mode
  1015.       (set-buffer (find-file-noselect (dired-get-filename))))
  1016.   (while vc-parent-buffer
  1017.       (pop-to-buffer vc-parent-buffer))
  1018.   (if (and buffer-file-name (vc-name buffer-file-name))
  1019.       (progn
  1020.     (vc-backend-print-log buffer-file-name)
  1021.     (pop-to-buffer (get-buffer-create "*vc*"))
  1022.     (vc-shrink-to-fit)
  1023.     (goto-char (point-min))
  1024.     )
  1025.     (vc-registration-error buffer-file-name)
  1026.     )
  1027.   )
  1028.  
  1029. ;;;###autoload
  1030. (defun vc-revert-buffer ()
  1031.   "Revert the current buffer's file back to the latest checked-in version.
  1032. This asks for confirmation if the buffer contents are not identical
  1033. to that version."
  1034.   (interactive)
  1035.   (if vc-dired-mode
  1036.       (find-file-other-window (dired-get-filename)))
  1037.   (while vc-parent-buffer
  1038.       (pop-to-buffer vc-parent-buffer))
  1039.   (let ((file buffer-file-name)
  1040.     (obuf (current-buffer)) (changed (vc-diff nil)))
  1041.     (if (and changed (or vc-suppress-confirm
  1042.              (not (yes-or-no-p "Discard changes? "))))
  1043.     (progn
  1044.       (delete-window)
  1045.       (error "Revert cancelled"))
  1046.       (set-buffer obuf))
  1047.     (if changed
  1048.     (delete-window))
  1049.     (vc-backend-revert file)
  1050.     (vc-resynch-window file t t)
  1051.     )
  1052.   )
  1053.  
  1054. ;;;###autoload
  1055. (defun vc-cancel-version (norevert)
  1056.   "Get rid of most recently checked in version of this file.
  1057. A prefix argument means do not revert the buffer afterwards."
  1058.   (interactive "P")
  1059.   (if vc-dired-mode
  1060.       (find-file-other-window (dired-get-filename)))
  1061.   (while vc-parent-buffer
  1062.     (pop-to-buffer vc-parent-buffer))
  1063.   (let* ((target (concat (vc-latest-version (buffer-file-name))))
  1064.     (yours (concat (vc-your-latest-version (buffer-file-name))))
  1065.     (prompt (if (string-equal yours target)
  1066.             "Remove your version %s from master? "
  1067.           "Version %s was not your change.  Remove it anyway? ")))
  1068.     (if (null (yes-or-no-p (format prompt target)))
  1069.     nil
  1070.       (vc-backend-uncheck (buffer-file-name) target)
  1071.       (if (or norevert
  1072.           (not (yes-or-no-p "Revert buffer to most recent remaining version? ")))
  1073.       (vc-mode-line (buffer-file-name))
  1074.     (vc-checkout (buffer-file-name) nil)))
  1075.     ))
  1076.  
  1077. (defun vc-rename-file (old new)
  1078.   "Rename file OLD to NEW, and rename its master file likewise."
  1079.   (interactive "fVC rename file: \nFRename to: ")
  1080.   (let ((oldbuf (get-file-buffer old)))
  1081.     (if (buffer-modified-p oldbuf)
  1082.     (error "Please save files before moving them"))
  1083.     (if (get-file-buffer new)
  1084.     (error "Already editing new file name"))
  1085.     (let ((oldmaster (vc-name old)))
  1086.       (if oldmaster
  1087.     (if (vc-locking-user old)
  1088.         (error "Please check in files before moving them"))
  1089.     (if (or (file-symlink-p oldmaster)
  1090.         ;; This had FILE, I changed it to OLD. -- rms.
  1091.         (file-symlink-p (vc-backend-subdirectory-name old)))
  1092.         (error "This is not a safe thing to do in the presence of symbolic links"))
  1093.     (rename-file oldmaster (vc-name new)))
  1094.       (if (or (not oldmaster) (file-exists-p old))
  1095.       (rename-file old new)))
  1096. ; ?? Renaming a file might change its contents due to keyword expansion.
  1097. ; We should really check out a new copy if the old copy was precisely equal
  1098. ; to some checked in version.  However, testing for this is tricky....
  1099.     (if oldbuf
  1100.     (save-excursion
  1101.       (set-buffer oldbuf)
  1102.       (set-visited-file-name new)
  1103.       (set-buffer-modified-p nil))))
  1104.   ;; This had FILE, I changed it to OLD. -- rms.
  1105.   (vc-backend-dispatch old
  1106.                (vc-record-rename old new)
  1107.                nil)
  1108.   )
  1109.  
  1110. ;;;###autoload
  1111. (defun vc-update-change-log (&rest args)
  1112.   "Find change log file and add entries from recent RCS logs.
  1113. The mark is left at the end of the text prepended to the change log.
  1114. With prefix arg of C-u, only find log entries for the current buffer's file.
  1115. With any numeric prefix arg, find log entries for all files currently visited.
  1116. Otherwise, find log entries for all registered files in the default directory.
  1117. From a program, any arguments are passed to the `rcs2log' script."
  1118.   (interactive
  1119.    (cond ((consp current-prefix-arg)    ;C-u
  1120.       (list buffer-file-name))
  1121.      (current-prefix-arg        ;Numeric argument.
  1122.       (let ((files nil)
  1123.         (buffers (buffer-list))
  1124.         file)
  1125.         (while buffers
  1126.           (setq file (buffer-file-name (car buffers)))
  1127.           (and file (vc-backend-deduce file)
  1128.            (setq files (cons file files)))
  1129.           (setq buffers (cdr buffers)))
  1130.         files))
  1131.      (t
  1132.       (let ((RCS (concat default-directory "RCS")))
  1133.         (and (file-directory-p RCS)
  1134.          (mapcar (function
  1135.               (lambda (f)
  1136.                 (if (string-match "\\(.*\\),v$" f)
  1137.                 (substring f 0 (match-end 1))
  1138.                   f)))
  1139.              (directory-files RCS nil "...\\|^[^.]\\|^.[^.]")))))))
  1140.   (let ((odefault default-directory))
  1141.     (find-file-other-window (find-change-log))
  1142.     (barf-if-buffer-read-only)
  1143.     (vc-buffer-sync)
  1144.     (undo-boundary)
  1145.     (goto-char (point-min))
  1146.     (push-mark)
  1147.     (message "Computing change log entries...")
  1148.     (message "Computing change log entries... %s"
  1149.          (if (or (null args)
  1150.              (eq 0 (apply 'call-process "rcs2log" nil t nil
  1151.                   (mapcar (function
  1152.                        (lambda (f)
  1153.                          (file-relative-name
  1154.                           (if (file-name-absolute-p f)
  1155.                           f
  1156.                         (concat odefault f)))))
  1157.                       args))))
  1158.          "done" "failed"))))
  1159.  
  1160. ;; Functions for querying the master and lock files.
  1161.  
  1162. (defun vc-match-substring (bn)
  1163.   (buffer-substring (match-beginning bn) (match-end bn)))
  1164.  
  1165. (defun vc-parse-buffer (patterns &optional file properties)
  1166.   ;; Use PATTERNS to parse information out of the current buffer
  1167.   ;; by matching each regular expression in the list and returning \\1.
  1168.   ;; If a regexp has two tag brackets, assume the second is a date
  1169.   ;; field and we want the most recent entry matching the template.
  1170.   ;; If FILE and PROPERTIES are given, the latter must be a list of
  1171.   ;; properties of the same length as PATTERNS; each property is assigned 
  1172.   ;; the corresponding value.
  1173.   (mapcar (function (lambda (p)
  1174.          (goto-char (point-min))
  1175.          (if (string-match "\\\\(.*\\\\(" p)
  1176.          (let ((latest-date "") (latest-val))
  1177.            (while (re-search-forward p nil t)
  1178.              (let ((date (vc-match-substring 2)))
  1179.                (if (string< latest-date date)
  1180.                (progn
  1181.                  (setq latest-date date)
  1182.                  (setq latest-val
  1183.                    (vc-match-substring 1))))))
  1184.            latest-val))
  1185.          (prog1
  1186.          (and (re-search-forward p nil t)
  1187.               (let ((value (vc-match-substring 1)))
  1188.             (if file
  1189.                 (vc-file-setprop file (car properties) value))
  1190.             value))
  1191.            (setq properties (cdr properties)))))
  1192.       patterns)
  1193.   )
  1194.  
  1195. (defun vc-master-info (file fields &optional rfile properties)
  1196.   ;; Search for information in a master file.
  1197.   (if (and file (file-exists-p file))
  1198.       (save-excursion
  1199.     (let ((buf))
  1200.       (setq buf (create-file-buffer file))
  1201.       (set-buffer buf))
  1202.     (erase-buffer)
  1203.     (insert-file-contents file nil)
  1204.     (set-buffer-modified-p nil)
  1205.     (auto-save-mode nil)
  1206.     (prog1
  1207.         (vc-parse-buffer fields rfile properties)
  1208.       (kill-buffer (current-buffer)))
  1209.     )
  1210.     (if rfile
  1211.     (mapcar
  1212.      (function (lambda (p) (vc-file-setprop rfile p nil)))
  1213.      properties))
  1214.     )
  1215.   )
  1216.  
  1217. (defun vc-log-info (command file patterns &optional properties)
  1218.   ;; Search for information in log program output
  1219.   (if (and file (file-exists-p file))
  1220.       (save-excursion
  1221.     (let ((buf))
  1222.       (setq buf (get-buffer-create "*vc*"))
  1223.       (set-buffer buf))
  1224.     (apply 'vc-do-command 0 command file nil)
  1225.     (set-buffer-modified-p nil)
  1226.     (prog1
  1227.         (vc-parse-buffer patterns file properties)
  1228.       (kill-buffer (current-buffer))
  1229.       )
  1230.     )
  1231.     (if file
  1232.     (mapcar
  1233.      (function (lambda (p) (vc-file-setprop file p nil)))
  1234.      properties))
  1235.     )
  1236.   )
  1237.  
  1238. (defun vc-locking-user (file)
  1239.   "Return the name of the person currently holding a lock on FILE.
  1240. Return nil if there is no such person."
  1241.   (setq file (expand-file-name file))    ;; ??? Work around bug in 19.0.4
  1242.   (if (or (not vc-keep-workfiles)
  1243.       (eq vc-mistrust-permissions 't)
  1244.       (and vc-mistrust-permissions
  1245.            (funcall vc-mistrust-permissions (vc-backend-subdirectory-name file))))
  1246.       (vc-true-locking-user file)
  1247.     ;; This implementation assumes that any file which is under version
  1248.     ;; control and has -rw-r--r-- is locked by its owner.  This is true
  1249.     ;; for both RCS and SCCS, which keep unlocked files at -r--r--r--.
  1250.     ;; We have to be careful not to exclude files with execute bits on;
  1251.     ;; scripts can be under version control too.  The advantage of this
  1252.     ;; hack is that calls to the very expensive vc-fetch-properties
  1253.     ;; function only have to be made if (a) the file is locked by someone
  1254.     ;; other than the current user, or (b) some untoward manipulation
  1255.     ;; behind vc's back has changed the owner or the `group' or `other'
  1256.     ;; write bits.
  1257.     (let ((attributes (file-attributes file)))
  1258.       (cond ((string-match ".r-.r-.r-." (nth 8 attributes))
  1259.          nil)
  1260.         ((and (= (nth 2 attributes) (user-uid))
  1261.           (string-match ".rw.r-.r-." (nth 8 attributes)))
  1262.          (user-login-name))
  1263.         (t
  1264.          (vc-true-locking-user file))))))
  1265.  
  1266. (defun vc-true-locking-user (file)
  1267.   ;; The slow but reliable version
  1268.   (vc-fetch-properties file)
  1269.   (vc-file-getprop file 'vc-locking-user))
  1270.  
  1271. (defun vc-latest-version (file)
  1272.   ;; Return version level of the latest version of FILE
  1273.   (vc-fetch-properties file)
  1274.   (vc-file-getprop file 'vc-latest-version))
  1275.  
  1276. (defun vc-your-latest-version (file)
  1277.   ;; Return version level of the latest version of FILE checked in by you
  1278.   (vc-fetch-properties file)
  1279.   (vc-file-getprop file 'vc-your-latest-version))
  1280.  
  1281. ;; Collect back-end-dependent stuff here
  1282. ;;
  1283. ;; Everything eventually funnels through these functions.  To implement
  1284. ;; support for a new version-control system, add another branch to the
  1285. ;; vc-backend-dispatch macro and fill it in in each call.  The variable
  1286. ;; vc-master-templates in vc-hooks.el will also have to change.
  1287.  
  1288. (defmacro vc-backend-dispatch (f s r)
  1289.   "Execute FORM1 or FORM2 depending on whether we're using SCCS or RCS."
  1290.   (list 'let (list (list 'type (list 'vc-backend-deduce f)))
  1291.     (list 'cond
  1292.           (list (list 'eq 'type (quote 'SCCS)) s)    ;; SCCS
  1293.           (list (list 'eq 'type (quote 'RCS)) r)    ;; RCS
  1294.           )))
  1295.  
  1296. (defun vc-lock-file (file)
  1297.   ;; Generate lock file name corresponding to FILE
  1298.   (let ((master (vc-name file)))
  1299.     (and
  1300.      master
  1301.      (string-match "\\(.*/\\)s\\.\\(.*\\)" master)
  1302.      (concat
  1303.       (substring master (match-beginning 1) (match-end 1))
  1304.       "p."
  1305.       (substring master (match-beginning 2) (match-end 2))))))
  1306.  
  1307.  
  1308. (defun vc-fetch-properties (file)
  1309.   ;; Re-fetch all properties associated with the given file.
  1310.   ;; Currently these properties are:
  1311.   ;;    vc-locking-user
  1312.   ;;    vc-locked-version
  1313.   ;;    vc-latest-version
  1314.   ;;    vc-your-latest-version
  1315.   (vc-backend-dispatch
  1316.    file
  1317.    ;; SCCS
  1318.    (progn
  1319.      (vc-master-info (vc-lock-file file)
  1320.              (list
  1321.               "^[^ ]+ [^ ]+ \\([^ ]+\\)"
  1322.               "^\\([^ ]+\\)")
  1323.              file
  1324.              '(vc-locking-user vc-locked-version))
  1325.      (vc-master-info (vc-name file)
  1326.           (list
  1327.            "^\001d D \\([^ ]+\\)"
  1328.            (concat "^\001d D \\([^ ]+\\) .* " 
  1329.                (regexp-quote (user-login-name)) " ")
  1330.            )
  1331.           file
  1332.           '(vc-latest-version vc-your-latest-version))
  1333.      )
  1334.    ;; RCS
  1335.    (vc-log-info "rlog" file
  1336.         (list
  1337.          "^locks: strict\n\t\\([^:]+\\)"
  1338.          "^locks: strict\n\t[^:]+: \\(.+\\)"
  1339.          "^revision[\t ]+\\([0-9.]+\\).*\ndate: \\([ /0-9:]+\\);"
  1340.          (concat
  1341.           "^revision[\t ]+\\([0-9.]+\\)\n.*author: "
  1342.           (regexp-quote (user-login-name))
  1343.           ";"))
  1344.         '(vc-locking-user vc-locked-version
  1345.                   vc-latest-version vc-your-latest-version))
  1346.    ))
  1347.  
  1348. (defun vc-backend-subdirectory-name (&optional file)
  1349.   ;; Where the master and lock files for the current directory are kept
  1350.   (symbol-name
  1351.    (or
  1352.     (and file (vc-backend-deduce file))
  1353.     vc-default-back-end
  1354.     (setq vc-default-back-end (if (vc-find-binary "rcs") 'RCS 'SCCS)))))
  1355.  
  1356. (defun vc-backend-admin (file &optional rev comment)
  1357.   ;; Register a file into the version-control system
  1358.   ;; Automatically retrieves a read-only version of the file with
  1359.   ;; keywords expanded if vc-keep-workfiles is non-nil, otherwise
  1360.   ;; it deletes the workfile.
  1361.   (vc-file-clearprops file)
  1362.   (or vc-default-back-end
  1363.       (setq vc-default-back-end (if (vc-find-binary "rcs") 'RCS 'SCCS)))
  1364.   (message "Registering %s..." file)
  1365.   (let ((backend
  1366.      (cond
  1367.       ((file-exists-p (vc-backend-subdirectory-name)) vc-default-back-end)
  1368.       ((file-exists-p "RCS") 'RCS)
  1369.       ((file-exists-p "SCCS") 'SCCS)
  1370.       (t vc-default-back-end))))
  1371.     (cond ((eq backend 'SCCS)
  1372.        (vc-do-command 0 "admin" file    ;; SCCS
  1373.               (and rev (concat "-r" rev))
  1374.               "-fb"
  1375.               (concat "-i" file)
  1376.               (and comment (concat "-y" comment))
  1377.               (format
  1378.                (car (rassq 'SCCS vc-master-templates))
  1379.                (or (file-name-directory file) "")
  1380.                (file-name-nondirectory file)))
  1381.        (delete-file file)
  1382.        (if vc-keep-workfiles
  1383.            (vc-do-command 0 "get" file)))
  1384.       ((eq backend 'RCS)
  1385.        (vc-do-command 0 "ci" file    ;; RCS
  1386.               (concat (if vc-keep-workfiles "-u" "-r") rev)
  1387.               (and comment (concat "-t-" comment))
  1388.               file)
  1389.        )))
  1390.   (message "Registering %s...done" file)
  1391.   )
  1392.  
  1393. (defun vc-backend-checkout (file &optional writable rev)
  1394.   ;; Retrieve a copy of a saved version into a workfile
  1395.   (message "Checking out %s..." file)
  1396.   (vc-backend-dispatch file
  1397.    (progn
  1398.      (vc-do-command 0 "get" file    ;; SCCS
  1399.             (if writable "-e")
  1400.             (and rev (concat "-r" (vc-lookup-triple file rev))))
  1401.      )
  1402.    (vc-do-command 0 "co" file    ;; RCS
  1403.           (if writable "-l")
  1404.           (and rev (concat "-r" rev)))
  1405.    )
  1406.   (vc-file-setprop file 'vc-checkout-time (nth 5 (file-attributes file)))
  1407.   (message "Checking out %s...done" file)
  1408.   )
  1409.  
  1410. (defun vc-backend-logentry-check (file)
  1411.   (vc-backend-dispatch file
  1412.    (if (>= (buffer-size) 512)    ;; SCCS
  1413.        (progn
  1414.      (goto-char 512)
  1415.      (error
  1416.       "Log must be less than 512 characters; point is now at pos 512")))
  1417.    nil)
  1418.   )
  1419.  
  1420. (defun vc-backend-checkin (file &optional rev comment)
  1421.   ;; Register changes to FILE as level REV with explanatory COMMENT.
  1422.   ;; Automatically retrieves a read-only version of the file with
  1423.   ;; keywords expanded if vc-keep-workfiles is non-nil, otherwise
  1424.   ;; it deletes the workfile.
  1425.   (message "Checking in %s..." file)
  1426.   (save-excursion
  1427.     ;; Change buffers to get local value of vc-checkin-switches.
  1428.     (set-buffer (or (get-file-buffer file) (current-buffer)))
  1429.     (vc-backend-dispatch file
  1430.       (progn
  1431.     (apply 'vc-do-command 0 "delta" file
  1432.            (if rev (concat "-r" rev))
  1433.            (concat "-y" comment)
  1434.            vc-checkin-switches)
  1435.     (if vc-keep-workfiles
  1436.         (vc-do-command 0 "get" file))
  1437.     )
  1438.       (apply 'vc-do-command 0 "ci" file
  1439.          (concat (if vc-keep-workfiles "-u" "-r") rev)
  1440.          (concat "-m" comment)
  1441.          vc-checkin-switches)
  1442.       ))
  1443.   (vc-file-setprop file 'vc-locking-user nil)
  1444.   (message "Checking in %s...done" file)
  1445.   )
  1446.  
  1447. (defun vc-backend-revert (file)
  1448.   ;; Revert file to latest checked-in version.
  1449.   (message "Reverting %s..." file)
  1450.   (vc-backend-dispatch
  1451.    file
  1452.    (progn            ;; SCCS
  1453.      (vc-do-command 0 "unget" file nil)
  1454.      (vc-do-command 0 "get" file nil))
  1455.    (progn
  1456.      (delete-file file)        ;; RCS
  1457.      (vc-do-command 0 "co" file "-u")))
  1458.   (vc-file-setprop file 'vc-locking-user nil)
  1459.   (message "Reverting %s...done" file)
  1460.   )
  1461.  
  1462. (defun vc-backend-steal (file &optional rev)
  1463.   ;; Steal the lock on the current workfile.  Needs RCS 5.6.2 or later for -M.
  1464.   (message "Stealing lock on %s..." file)
  1465.   (progn
  1466.     (vc-do-command 0 "unget" file "-n" (if rev (concat "-r" rev)))
  1467.     (vc-do-command 0 "get" file "-g" (if rev (concat "-r" rev)))
  1468.     )
  1469.   (progn
  1470.     (vc-do-command 0 "rcs" "-M" (concat "-u" rev) file)
  1471.     (delete-file file)
  1472.     (vc-do-command 0 "rcs" (concat "-l" rev) file)
  1473.     )
  1474.   (vc-file-setprop file 'vc-locking-user (user-login-name))
  1475.   (message "Stealing lock on %s...done" file)
  1476.   )  
  1477.  
  1478. (defun vc-backend-uncheck (file target)
  1479.   ;; Undo the latest checkin.  Note: this code will have to get a lot
  1480.   ;; smarter when we support multiple branches.
  1481.   (message "Removing last change from %s..." file)
  1482.   (vc-backend-dispatch file
  1483.    (vc-do-command 0 "rmdel" file (concat "-r" target))
  1484.    (vc-do-command 0 "rcs" file (concat "-o" target))
  1485.    )
  1486.   (message "Removing last change from %s...done" file)
  1487.   )
  1488.  
  1489. (defun vc-backend-print-log (file)
  1490.   ;; Print change log associated with FILE to buffer *vc*.
  1491.   (vc-do-command 0
  1492.          (vc-backend-dispatch file "prs" "rlog")
  1493.          file)
  1494.   )
  1495.  
  1496. (defun vc-backend-assign-name (file name)
  1497.   ;; Assign to a FILE's latest version a given NAME.
  1498.   (vc-backend-dispatch file
  1499.    (vc-add-triple name file (vc-latest-version file))    ;; SCCS
  1500.    (vc-do-command 0 "rcs" file (concat "-n" name ":"))    ;; RCS
  1501.    )
  1502.   )
  1503.  
  1504. (defun vc-backend-diff (file oldvers &optional newvers)
  1505.   ;; Get a difference report between two versions
  1506.   (if (eq (vc-backend-deduce file) 'SCCS)
  1507.       (setq oldvers (vc-lookup-triple file oldvers))
  1508.       (setq newvers (vc-lookup-triple file newvers)))
  1509.   (apply 'vc-do-command 1
  1510.      (or (vc-backend-dispatch file "vcdiff" "rcsdiff")
  1511.          (vc-registration-error file))
  1512.      file
  1513.      "-q"
  1514.      (and oldvers (concat "-r" oldvers))
  1515.      (and newvers (concat "-r" newvers))
  1516.      (if (listp diff-switches)
  1517.          diff-switches
  1518.        (list diff-switches))
  1519.   ))
  1520.  
  1521. (defun vc-check-headers ()
  1522.   "Check if the current file has any headers in it."
  1523.   (interactive)
  1524.   (save-excursion
  1525.     (goto-char (point-min))
  1526.     (vc-backend-dispatch buffer-file-name
  1527.      (re-search-forward  "%[MIRLBSDHTEGUYFPQCZWA]%" nil t)    ;; SCCS
  1528.      (re-search-forward "\\$[A-Za-z\300-\326\330-\366\370-\377]+\\(: [\t -#%-\176\240-\377]*\\)?\\$" nil t)        ;; RCS
  1529.      )
  1530.     ))
  1531.  
  1532. ;; Back-end-dependent stuff ends here.
  1533.  
  1534. ;; Set up key bindings for use while editing log messages
  1535.  
  1536. (defun vc-log-mode ()
  1537.   "Minor mode for driving version-control tools.
  1538. These bindings are added to the global keymap when you enter this mode:
  1539. \\[vc-next-action]        perform next logical version-control operation on current file
  1540. \\[vc-register]            register current file
  1541. \\[vc-toggle-read-only]        like next-action, but won't register files
  1542. \\[vc-insert-headers]        insert version-control headers in current file
  1543. \\[vc-print-log]        display change history of current file
  1544. \\[vc-revert-buffer]        revert buffer to latest version
  1545. \\[vc-cancel-version]        undo latest checkin
  1546. \\[vc-diff]        show diffs between file versions
  1547. \\[vc-directory]        show all files locked by any user in or below .
  1548. \\[vc-update-change-log]        add change log entry from recent checkins
  1549.  
  1550. While you are entering a change log message for a version, the following
  1551. additional bindings will be in effect.
  1552.  
  1553. \\[vc-finish-logentry]    proceed with check in, ending log message entry
  1554.  
  1555. Whenever you do a checkin, your log comment is added to a ring of
  1556. saved comments.  These can be recalled as follows:
  1557.  
  1558. \\[vc-next-comment]    replace region with next message in comment ring
  1559. \\[vc-previous-comment]    replace region with previous message in comment ring
  1560. \\[vc-comment-search-reverse]    search backward for regexp in the comment ring
  1561. \\[vc-comment-search-forward]    search backward for regexp in the comment ring
  1562.  
  1563. Entry to the change-log submode calls the value of text-mode-hook, then
  1564. the value of vc-log-mode-hook.
  1565.  
  1566. Global user options:
  1567.     vc-initial-comment    If non-nil, require user to enter a change
  1568.                 comment upon first checkin of the file.
  1569.  
  1570.     vc-keep-workfiles    Non-nil value prevents workfiles from being
  1571.                 deleted when changes are checked in
  1572.  
  1573.         vc-suppress-confirm     Suppresses some confirmation prompts,
  1574.                 notably for reversions.
  1575.  
  1576.     vc-header-alist        Which keywords to insert when adding headers
  1577.                 with \\[vc-insert-headers].  Defaults to
  1578.                 '(\"\%\W\%\") under SCCS, '(\"\$Id\$\") under RCS.
  1579.  
  1580.     vc-static-header-alist    By default, version headers inserted in C files
  1581.                 get stuffed in a static string area so that
  1582.                 ident(RCS) or what(SCCS) can see them in the
  1583.                 compiled object code.  You can override this
  1584.                 by setting this variable to nil, or change
  1585.                 the header template by changing it.
  1586.  
  1587.     vc-command-messages    if non-nil, display run messages from the
  1588.                 actual version-control utilities (this is
  1589.                 intended primarily for people hacking vc
  1590.                 itself).
  1591. "
  1592.   (interactive)
  1593.   (set-syntax-table text-mode-syntax-table)
  1594.   (use-local-map vc-log-entry-mode)
  1595.   (setq local-abbrev-table text-mode-abbrev-table)
  1596.   (setq major-mode 'vc-log-mode)
  1597.   (setq mode-name "VC-Log")
  1598.   (make-local-variable 'vc-log-file)
  1599.   (make-local-variable 'vc-log-version)
  1600.   (make-local-variable 'vc-comment-ring-index)
  1601.   (set-buffer-modified-p nil)
  1602.   (setq buffer-file-name nil)
  1603.   (run-hooks 'text-mode-hook 'vc-log-mode-hook)
  1604. )
  1605.  
  1606. ;; Initialization code, to be done just once at load-time
  1607. (if vc-log-entry-mode
  1608.     nil
  1609.   (setq vc-log-entry-mode (make-sparse-keymap))
  1610.   (define-key vc-log-entry-mode "\M-n" 'vc-next-comment)
  1611.   (define-key vc-log-entry-mode "\M-p" 'vc-previous-comment)
  1612.   (define-key vc-log-entry-mode "\M-r" 'vc-comment-search-reverse)
  1613.   (define-key vc-log-entry-mode "\M-s" 'vc-comment-search-forward)
  1614.   (define-key vc-log-entry-mode "\C-c\C-c" 'vc-finish-logentry)
  1615.   )
  1616.  
  1617. ;;; These things should probably be generally available
  1618.  
  1619. (defun vc-shrink-to-fit ()
  1620.   "Shrink window vertically until it's just large enough to contain its text."
  1621.   (let ((minsize (1+ (count-lines (point-min) (point-max)))))
  1622.     (if (< minsize (window-height))
  1623.     (let ((window-min-height 2))
  1624.       (shrink-window (- (window-height) minsize))))))
  1625.  
  1626. (defun vc-file-tree-walk (func &rest args)
  1627.   "Walk recursively through default directory.
  1628. Invoke FUNC f ARGS on each non-directory file f underneath it."
  1629.   (vc-file-tree-walk-internal default-directory func args)
  1630.   (message "Traversing directory %s...done" default-directory))
  1631.  
  1632. (defun vc-file-tree-walk-internal (file func args)
  1633.   (if (not (file-directory-p file))
  1634.       (apply func file args)
  1635.     (message "Traversing directory %s..." file)
  1636.     (let ((dir (file-name-as-directory file)))
  1637.       (mapcar
  1638.        (function
  1639.     (lambda (f) (or
  1640.              (string-equal f ".")
  1641.              (string-equal f "..")
  1642.              (let ((dirf (concat dir f)))
  1643.             (or
  1644.              (file-symlink-p dirf) ;; Avoid possible loops
  1645.              (vc-file-tree-walk-internal dirf func args))))))
  1646.        (directory-files dir)))))
  1647.  
  1648. (provide 'vc)
  1649.  
  1650. ;;; DEVELOPER'S NOTES ON CONCURRENCY PROBLEMS IN THIS CODE
  1651. ;;;
  1652. ;;; These may be useful to anyone who has to debug or extend the package.
  1653. ;;; 
  1654. ;;; A fundamental problem in VC is that there are time windows between
  1655. ;;; vc-next-action's computations of the file's version-control state and
  1656. ;;; the actions that change it.  This is a window open to lossage in a
  1657. ;;; multi-user environment; someone else could nip in and change the state
  1658. ;;; of the master during it.
  1659. ;;; 
  1660. ;;; The performance problem is that rlog/prs calls are very expensive; we want
  1661. ;;; to avoid them as much as possible.
  1662. ;;; 
  1663. ;;; ANALYSIS:
  1664. ;;; 
  1665. ;;; The performance problem, it turns out, simplifies in practice to the
  1666. ;;; problem of making vc-locking-user fast.  The two other functions that call
  1667. ;;; prs/rlog will not be so commonly used that the slowdown is a problem; one
  1668. ;;; makes snapshots, the other deletes the calling user's last change in the
  1669. ;;; master.
  1670. ;;; 
  1671. ;;; The race condition implies that we have to either (a) lock the master
  1672. ;;; during the entire execution of vc-next-action, or (b) detect and
  1673. ;;; recover from errors resulting from dispatch on an out-of-date state.
  1674. ;;; 
  1675. ;;; Alternative (a) appears to be unfeasible.  The problem is that we can't
  1676. ;;; guarantee that the lock will ever be removed.  Suppose a user starts a
  1677. ;;; checkin, the change message buffer pops up, and the user, having wandered
  1678. ;;; off to do something else, simply forgets about it?
  1679. ;;; 
  1680. ;;; Alternative (b), on the other hand, works well with a cheap way to speed up
  1681. ;;; vc-locking-user.  Usually, if a file is registered, we can read its locked/
  1682. ;;; unlocked state and its current owner from its permissions.
  1683. ;;; 
  1684. ;;; This shortcut will fail if someone has manually changed the workfile's
  1685. ;;; permissions; also if developers are munging the workfile in several
  1686. ;;; directories, with symlinks to a master (in this latter case, the
  1687. ;;; permissions shortcut will fail to detect a lock asserted from another
  1688. ;;; directory).
  1689. ;;; 
  1690. ;;; Note that these cases correspond exactly to the errors which could happen
  1691. ;;; because of a competing checkin/checkout race in between two instances of
  1692. ;;; vc-next-action.
  1693. ;;; 
  1694. ;;; For VC's purposes, a workfile/master pair may have the following states:
  1695. ;;; 
  1696. ;;; A. Unregistered.  There is a workfile, there is no master.
  1697. ;;; 
  1698. ;;; B. Registered and not locked by anyone.
  1699. ;;; 
  1700. ;;; C. Locked by calling user and unchanged.
  1701. ;;; 
  1702. ;;; D. Locked by the calling user and changed.
  1703. ;;; 
  1704. ;;; E. Locked by someone other than the calling user.
  1705. ;;; 
  1706. ;;; This makes for 25 states and 20 error conditions.  Here's the matrix:
  1707. ;;; 
  1708. ;;; VC's idea of state
  1709. ;;;  |
  1710. ;;;  V  Actual state   RCS action              SCCS action          Effect
  1711. ;;;    A  B  C  D  E
  1712. ;;;  A .  1  2  3  4   ci -u -t-          admin -fb -i<file>      initial admin
  1713. ;;;  B 5  .  6  7  8   co -l              get -e                  checkout
  1714. ;;;  C 9  10 .  11 12  co -u              unget; get              revert
  1715. ;;;  D 13 14 15 .  16  ci -u -m<comment>  delta -y<comment>; get  checkin
  1716. ;;;  E 17 18 19 20 .   rcs -u -M ; rcs -l unget -n ; get -g       steal lock
  1717. ;;; 
  1718. ;;; All commands take the master file name as a last argument (not shown).
  1719. ;;; 
  1720. ;;; In the discussion below, a "self-race" is a pathological situation in
  1721. ;;; which VC operations are being attempted simultaneously by two or more
  1722. ;;; Emacsen running under the same username.
  1723. ;;; 
  1724. ;;; The vc-next-action code has the following windows:
  1725. ;;; 
  1726. ;;; Window P:
  1727. ;;;    Between the check for existence of a master file and the call to
  1728. ;;; admin/checkin in vc-buffer-admin (apparent state A).  This window may
  1729. ;;; never close if the initial-comment feature is on.
  1730. ;;; 
  1731. ;;; Window Q:
  1732. ;;;    Between the call to vc-workfile-unchanged-p in and the immediately
  1733. ;;; following revert (apparent state C).
  1734. ;;; 
  1735. ;;; Window R:
  1736. ;;;    Between the call to vc-workfile-unchanged-p in and the following
  1737. ;;; checkin (apparent state D).  This window may never close.
  1738. ;;; 
  1739. ;;; Window S:
  1740. ;;;    Between the unlock and the immediately following checkout during a
  1741. ;;; revert operation (apparent state C).  Included in window Q.
  1742. ;;; 
  1743. ;;; Window T:
  1744. ;;;    Between vc-locking-user and the following checkout (apparent state B).
  1745. ;;; 
  1746. ;;; Window U:
  1747. ;;;    Between vc-locking-user and the following revert (apparent state C).
  1748. ;;; Includes windows Q and S.
  1749. ;;; 
  1750. ;;; Window V:
  1751. ;;;    Between vc-locking-user and the following checkin (apparent state
  1752. ;;; D).  This window may never be closed if the user fails to complete the
  1753. ;;; checkin message.  Includes window R.
  1754. ;;; 
  1755. ;;; Window W:
  1756. ;;;    Between vc-locking-user and the following steal-lock (apparent
  1757. ;;; state E).  This window may never close if the user fails to complete
  1758. ;;; the steal-lock message.  Includes window X.
  1759. ;;; 
  1760. ;;; Window X:
  1761. ;;;    Between the unlock and the immediately following re-lock during a
  1762. ;;; steal-lock operation (apparent state E).  This window may never cloce
  1763. ;;; if the user fails to complete the steal-lock message.
  1764. ;;; 
  1765. ;;; Errors:
  1766. ;;; 
  1767. ;;; Apparent state A ---
  1768. ;;;
  1769. ;;; 1. File looked unregistered but is actually registered and not locked.
  1770. ;;; 
  1771. ;;;    Potential cause: someone else's admin during window P, with
  1772. ;;; caller's admin happening before their checkout.
  1773. ;;; 
  1774. ;;;    RCS: ci will fail with a "no lock set by <user>" message.
  1775. ;;;    SCCS: admin will fail with error (ad19).
  1776. ;;; 
  1777. ;;;    We can let these errors be passed up to the user.
  1778. ;;; 
  1779. ;;; 2. File looked unregistered but is actually locked by caller, unchanged.
  1780. ;;; 
  1781. ;;;    Potential cause: self-race during window P.
  1782. ;;; 
  1783. ;;;    RCS: will revert the file to the last saved version and unlock it.
  1784. ;;;    SCCS: will fail with error (ad19).
  1785. ;;; 
  1786. ;;;    Either of these consequences is acceptable.
  1787. ;;; 
  1788. ;;; 3. File looked unregistered but is actually locked by caller, changed.
  1789. ;;; 
  1790. ;;;    Potential cause: self-race during window P.
  1791. ;;; 
  1792. ;;;    RCS: will register the caller's workfile as a delta with a
  1793. ;;; null change comment (the -t- switch will be ignored).
  1794. ;;;    SCCS: will fail with error (ad19).
  1795. ;;; 
  1796. ;;; 4. File looked unregistered but is locked by someone else.
  1797. ;;; 
  1798. ;;;    Potential cause: someone else's admin during window P, with
  1799. ;;; caller's admin happening *after* their checkout.
  1800. ;;; 
  1801. ;;;    RCS: will fail with a "no lock set by <user>" message.
  1802. ;;;    SCCS: will fail with error (ad19).
  1803. ;;; 
  1804. ;;;    We can let these errors be passed up to the user.
  1805. ;;; 
  1806. ;;; Apparent state B ---
  1807. ;;;
  1808. ;;; 5. File looked registered and not locked, but is actually unregistered.
  1809. ;;; 
  1810. ;;;    Potential cause: master file got nuked during window P.
  1811. ;;; 
  1812. ;;;    RCS: will fail with "RCS/<file>: No such file or directory"
  1813. ;;;    SCCS: will fail with error ut4.
  1814. ;;; 
  1815. ;;;    We can let these errors be passed up to the user.
  1816. ;;; 
  1817. ;;; 6. File looked registered and not locked, but is actually locked by the
  1818. ;;; calling user and unchanged.
  1819. ;;; 
  1820. ;;;    Potential cause: self-race during window T.
  1821. ;;; 
  1822. ;;;    RCS: in the same directory as the previous workfile, co -l will fail
  1823. ;;; with "co error: writable foo exists; checkout aborted".  In any other
  1824. ;;; directory, checkout will succeed.
  1825. ;;;    SCCS: will fail with ge17.
  1826. ;;; 
  1827. ;;;    Either of these consequences is acceptable.
  1828. ;;; 
  1829. ;;; 7. File looked registered and not locked, but is actually locked by the
  1830. ;;; calling user and changed.
  1831. ;;; 
  1832. ;;;    As case 6.
  1833. ;;; 
  1834. ;;; 8. File looked registered and not locked, but is actually locked by another
  1835. ;;; user.
  1836. ;;; 
  1837. ;;;    Potential cause: someone else checks it out during window T.
  1838. ;;; 
  1839. ;;;    RCS: co error: revision 1.3 already locked by <user>
  1840. ;;;    SCCS: fails with ge4 (in directory) or ut7 (outside it).
  1841. ;;; 
  1842. ;;;    We can let these errors be passed up to the user.
  1843. ;;; 
  1844. ;;; Apparent state C ---
  1845. ;;;
  1846. ;;; 9. File looks locked by calling user and unchanged, but is unregistered.
  1847. ;;; 
  1848. ;;;    As case 5.
  1849. ;;; 
  1850. ;;; 10. File looks locked by calling user and unchanged, but is actually not
  1851. ;;; locked.
  1852. ;;; 
  1853. ;;;    Potential cause: a self-race in window U, or by the revert's
  1854. ;;; landing during window X of some other user's steal-lock or window S
  1855. ;;; of another user's revert.
  1856. ;;; 
  1857. ;;;    RCS: succeeds, refreshing the file from the identical version in
  1858. ;;; the master.
  1859. ;;;    SCCS: fails with error ut4 (p file nonexistent).
  1860. ;;;
  1861. ;;;    Either of these consequences is acceptable.
  1862. ;;; 
  1863. ;;; 11. File is locked by calling user.  It looks unchanged, but is actually
  1864. ;;; changed.
  1865. ;;; 
  1866. ;;;    Potential cause: the file would have to be touched by a self-race
  1867. ;;; during window Q.
  1868. ;;; 
  1869. ;;;    The revert will succeed, removing whatever changes came with
  1870. ;;; the touch.  It is theoretically possible that work could be lost.
  1871. ;;; 
  1872. ;;; 12. File looks like it's locked by the calling user and unchanged, but
  1873. ;;; it's actually locked by someone else.
  1874. ;;; 
  1875. ;;;    Potential cause: a steal-lock in window V.
  1876. ;;; 
  1877. ;;;    RCS: co error: revision <rev> locked by <user>; use co -r or rcs -u
  1878. ;;;    SCCS: fails with error un2
  1879. ;;; 
  1880. ;;;    We can pass these errors up to the user.
  1881. ;;; 
  1882. ;;; Apparent state D ---
  1883. ;;;
  1884. ;;; 13. File looks like it's locked by the calling user and changed, but it's
  1885. ;;; actually unregistered.
  1886. ;;; 
  1887. ;;;    Potential cause: master file got nuked during window P.
  1888. ;;; 
  1889. ;;;    RCS: Checks in the user's version as an initial delta.
  1890. ;;;    SCCS: will fail with error ut4.
  1891. ;;;
  1892. ;;;    This case is kind of nasty.  It means VC may fail to detect the
  1893. ;;; loss of previous version information.
  1894. ;;; 
  1895. ;;; 14. File looks like it's locked by the calling user and changed, but it's
  1896. ;;; actually unlocked.
  1897. ;;; 
  1898. ;;;    Potential cause: self-race in window V, or the checkin happening
  1899. ;;; during the window X of someone else's steal-lock or window S of
  1900. ;;; someone else's revert.
  1901. ;;; 
  1902. ;;;    RCS: ci will fail with "no lock set by <user>".
  1903. ;;;    SCCS: delta will fail with error ut4.
  1904. ;;; 
  1905. ;;; 15. File looks like it's locked by the calling user and changed, but it's
  1906. ;;; actually locked by the calling user and unchanged.
  1907. ;;; 
  1908. ;;;    Potential cause: another self-race --- a whole checkin/checkout
  1909. ;;; sequence by the calling user would have to land in window R.
  1910. ;;; 
  1911. ;;;    SCCS: checks in a redundant delta and leaves the file unlocked as usual.
  1912. ;;;    RCS: reverts to the file state as of the second user's checkin, leaving
  1913. ;;; the file unlocked.
  1914. ;;;
  1915. ;;;    It is theoretically possible that work could be lost under RCS.
  1916. ;;; 
  1917. ;;; 16. File looks like it's locked by the calling user and changed, but it's
  1918. ;;; actually locked by a different user.
  1919. ;;; 
  1920. ;;;    RCS: ci error: no lock set by <user>
  1921. ;;;    SCCS: unget will fail with error un2
  1922. ;;; 
  1923. ;;;    We can pass these errors up to the user.
  1924. ;;; 
  1925. ;;; Apparent state E ---
  1926. ;;;
  1927. ;;; 17. File looks like it's locked by some other user, but it's actually
  1928. ;;; unregistered.
  1929. ;;; 
  1930. ;;;    As case 13.
  1931. ;;; 
  1932. ;;; 18. File looks like it's locked by some other user, but it's actually
  1933. ;;; unlocked.
  1934. ;;; 
  1935. ;;;    Potential cause: someone released a lock during window W.
  1936. ;;; 
  1937. ;;;    RCS: The calling user will get the lock on the file.
  1938. ;;;    SCCS: unget -n will fail with cm4.
  1939. ;;; 
  1940. ;;;    Either of these consequences will be OK.
  1941. ;;; 
  1942. ;;; 19. File looks like it's locked by some other user, but it's actually
  1943. ;;; locked by the calling user and unchanged.
  1944. ;;; 
  1945. ;;;    Potential cause: the other user relinquishing a lock followed by
  1946. ;;; a self-race, both in window W.
  1947. ;;; 
  1948. ;;;     Under both RCS and SCCS, both unlock and lock will succeed, making
  1949. ;;; the sequence a no-op.
  1950. ;;; 
  1951. ;;; 20. File looks like it's locked by some other user, but it's actually
  1952. ;;; locked by the calling user and changed.
  1953. ;;; 
  1954. ;;;     As case 19.
  1955. ;;; 
  1956. ;;; PROBLEM CASES:
  1957. ;;; 
  1958. ;;;    In order of decreasing severity:
  1959. ;;; 
  1960. ;;;    Cases 11 and 15 under RCS are the only one that potentially lose work.
  1961. ;;; They would require a self-race for this to happen.
  1962. ;;; 
  1963. ;;;    Case 13 in RCS loses information about previous deltas, retaining
  1964. ;;; only the information in the current workfile.  This can only happen
  1965. ;;; if the master file gets nuked in window P.
  1966. ;;; 
  1967. ;;;    Case 3 in RCS and case 15 under SCCS insert a redundant delta with
  1968. ;;; no change comment in the master.  This would require a self-race in
  1969. ;;; window P or R respectively.
  1970. ;;; 
  1971. ;;;    Cases 2, 10, 19 and 20 do extra work, but make no changes.
  1972. ;;; 
  1973. ;;;    Unfortunately, it appears to me that no recovery is possible in these
  1974. ;;; cases.  They don't yield error messages, so there's no way to tell that
  1975. ;;; a race condition has occurred.
  1976. ;;; 
  1977. ;;;    All other cases don't change either the workfile or the master, and
  1978. ;;; trigger command errors which the user will see.
  1979. ;;; 
  1980. ;;;    Thus, there is no explicit recovery code.
  1981.  
  1982. ;;; vc.el ends here
  1983.